﻿#region Copyright(c) 2006 ZO, All right reserved.
// -----------------------------------------------------------------------------
// Copyright(c) 2006 ZO, All right reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//   1.  Redistribution of source code must retain the above copyright notice,
//       this list of conditions and the following disclaimer.
//   2.  Redistribution in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//   3.  The name of the author may not be used to endorse or promote products
//       derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
// EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// -----------------------------------------------------------------------------
#endregion


#region Using directives

using System.Text;
using ZO.SmartCore.Core;
using ZO.SmartCore.Standards.StringPrep.Properties;

#endregion

namespace ZO.SmartCore.Standards.StringPrep
{
    /// <summary>
    /// Class for encapsulating a Bidirectional Characters table.
    /// </summary>
    public abstract class BidirectionalTable
    {

        #region Constructors
        /// <summary>
        /// Initializes a new instance of the <see cref="BidirectionalTable"/> class.
        /// </summary>
        protected BidirectionalTable() { }

        #endregion

        #region Destructor

        #endregion

        #region Fields

        #endregion

        #region Events

        #endregion

        #region Operators

        #endregion

        #region Properties

        #endregion

        #region Methods
        /// <summary>
        /// Creates a new BidirectionalTable based on the given table.
        /// </summary>
        /// <param name="prohibitedChars">The table of prohibited characters.
        /// <p>The format of <tt>chars</tt> is an array of ranges; each array within
        /// <tt>values</tt> is expected to be either single characters (array length
        /// is 1) or a min/max range (array length is 2).</p></param>
        /// <param name="rlChars">The RandALCat characters.</param>
        /// <param name="leftChars">The left chars.</param>
        /// <returns>The BidirectionalTable over values.</returns>
        public static BidirectionalTable Create(char[][] prohibitedChars, char[][] rlChars, char[][] leftChars)
        {
            if (prohibitedChars == null)
                throw new ArgumentNullException("chars", Resources.NullCharArray);

            for (int idx = 0; idx < prohibitedChars.Length; idx++)
            {
                if (prohibitedChars[idx] == null)
                    throw new ArgumentException(Resources.NullCharSubArray, "chars");
            }

            return new DefaultBidirectionalTable(prohibitedChars, rlChars, leftChars);
        }

        /// <summary>
        /// Verifies the character sequence
        /// </summary>
        /// <param name="text">The character sequence to verify.</param>
        /// <remarks>
        /// From RFC 3454, Section 6:
        /// In any profile that specifies bidirectional character handling, all
        /// three of the following requirements MUST be met:
        /// <ol>
        /// <li>The characters in section 5.8 MUST be prohibited.</li>
        /// <li>If a string contains any RandALCat character, the string MUST NOT
        /// contain any LCat character.</li>
        /// <li> If a string contains any RandALCat character, a RandALCat
        /// character MUST be the first character of the string, and a
        /// RandALCat character MUST be the last character of the string.</li>
        /// </ol>
        /// </remarks>
        public abstract void Verify(StringBuilder text);

        /// <summary>
        /// Verifies the character sequence
        /// </summary>
        /// <param name="text">The character sequence to verify.</param>
        /// <remarks>
        /// From RFC 3454, Section 6:
        /// In any profile that specifies bidirectional character handling, all
        /// three of the following requirements MUST be met:
        /// <ol>
        /// <li>The characters in section 5.8 MUST be prohibited.</li>
        /// <li>If a string contains any RandALCat character, the string MUST NOT
        /// contain any LCat character.</li>
        /// <li> If a string contains any RandALCat character, a RandALCat
        /// character MUST be the first character of the string, and a
        /// RandALCat character MUST be the last character of the string.</li>
        /// </ol>
        /// </remarks>
        public void Verify(string text)
        {
            if (text == null)
            {
                throw new ArgumentNullException("text");
            }

            this.Verify(new StringBuilder(text));
        } // Verify
        #endregion
    }
}
